类 FoxitPDFSDKPython3.Annot 继承关系图:

Public 成员函数
def	Annot ()
	构造函数。

def	Annot (annot)
	构造函数，使用另一个注释对象。更多...

def	GetAppearanceStream (type, appearance_state)
	获取具有指定类型和状态的注释外观流。更多...

def	GetBorderColor ()
	获取边框颜色。更多...

def	GetBorderInfo ()
	获取边框信息。更多...

def	GetContent ()
	获取内容。更多...

def	GetDeviceRect (matrix)
	获取设备坐标系统中的注释矩形。更多...

def	GetDict ()
	获取注释的字典对象。更多...

def	GetDisplayMatrix (page_display_matrix)
	获取显示矩阵，从到目标设备坐标系统。更多...

def	GetFlags ()
	获取注释标志。更多...

def	GetIndex ()
	获取当前注释在其所属页面中的索引。更多...

def	GetModifiedDateTime ()
	获取最后修改日期时间。更多...

def	GetOptionalContent ()
	获取注释可选内容的PDF字典。更多...

def	GetPage ()
	获取相关的PDF页面。更多...

def	GetRect ()
	获取矩形，以表示。更多...

def	GetType ()
	获取当前注释的实际注释类型。更多...

def	GetUniqueID ()
	获取唯一ID。更多...

def	HasProperty (property)
	当前注释是否具有指定的注释属性。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	IsMarkup ()
	检查当前注释是否为标记注释。更多...

def	Move (rect)
	将当前注释移动到新位置，由中的新矩形指定。更多...

def	Move (rect, is_reset_appearance)
	将当前注释移动到新位置，由中的新矩形指定。更多...

def	RemoveProperty (property)
	删除指定的注释属性。更多...

def	ResetAppearanceStream ()
	重置外观流。更多...

def	SetBorderColor (color)
	设置边框颜色。更多...

def	SetBorderInfo (border)
	设置边框信息。更多...

def	SetContent (content)
	设置内容。更多...

def	SetFlags (flags)
	设置注释标志。更多...

def	SetModifiedDateTime (date_time)
	设置最后修改日期时间。更多...

def	SetUniqueID (unique_id)
	设置唯一ID。更多...

静态 Public 属性
	e_3D = _fsdk.Annot_e_3D
	注释类型：3D注释。<PDF参考1.7>中的标准注释之一。

	e_AppearanceTypeDown = _fsdk.Annot_e_AppearanceTypeDown
	注释的按下外观。

	e_AppearanceTypeNormal = _fsdk.Annot_e_AppearanceTypeNormal
	注释的正常外观。

	e_AppearanceTypeRollover = _fsdk.Annot_e_AppearanceTypeRollover
	注释的悬停外观。

	e_Caret = _fsdk.Annot_e_Caret
	注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。

	e_Circle = _fsdk.Annot_e_Circle
	注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。

	e_FileAttachment = _fsdk.Annot_e_FileAttachment
	注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。

	e_FlagHidden = _fsdk.Annot_e_FlagHidden
	注释标志：隐藏。更多...

	e_FlagInvisible = _fsdk.Annot_e_FlagInvisible
	注释标志：不可见。更多...

	e_FlagLocked = _fsdk.Annot_e_FlagLocked
	注释标志：锁定。更多...

	e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents
	注释标志：锁定内容。更多...

	e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate
	注释标志：无旋转。更多...

	e_FlagNoView = _fsdk.Annot_e_FlagNoView
	注释标志：无视图。更多...

	e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom
	注释标志：无缩放。更多...

	e_FlagPrint = _fsdk.Annot_e_FlagPrint
	注释标志：打印。更多...

	e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly
	注释标志：只读。更多...

	e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView
	注释标志：切换无视图。更多...

	e_FreeText = _fsdk.Annot_e_FreeText
	注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。

	e_Highlight = _fsdk.Annot_e_Highlight
	注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。

	e_HighlightingInvert = _fsdk.Annot_e_HighlightingInvert
	高亮模式：反转，即反转注释矩形的内容。

	e_HighlightingNone = _fsdk.Annot_e_HighlightingNone
	高亮模式：无高亮。

	e_HighlightingOutline = _fsdk.Annot_e_HighlightingOutline
	高亮模式：轮廓，即反转注释的边框。

	e_HighlightingPush = _fsdk.Annot_e_HighlightingPush
	高亮模式：按下，即显示注释的按下外观（如果有）。

	e_HighlightingToggle = _fsdk.Annot_e_HighlightingToggle
	高亮模式：切换。这仅对小组件注释有用。

	e_Ink = _fsdk.Annot_e_Ink
	注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。

	e_Line = _fsdk.Annot_e_Line
	注释类型：直线注释。<PDF参考1.7>中的标准注释之一。

	e_Link = _fsdk.Annot_e_Link
	注释类型：链接注释。<PDF参考1.7>中的标准注释之一。

	e_MKEntryBackgroundColor = _fsdk.Annot_e_MKEntryBackgroundColor
	背景颜色条目。MK字典中的"BG"。

	e_MKEntryBorderColor = _fsdk.Annot_e_MKEntryBorderColor
	边框颜色条目。MK字典中的"BC"。

	e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption
	按下标题（或备用标题）条目。MK字典中的"AC"。更多...

	e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon
	按下图标（或备用图标）条目。MK字典中的"IX"。更多...

	e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation
	图标和标题关系条目。MK字典中的"TP"。更多...

	e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit
	图标适配信息条目。MK字典中的"IF"。更多...

	e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption
	正常标题条目。MK字典中的"CA"。更多...

	e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon
	正常图标条目。MK字典中的"I"。更多...

	e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption
	悬停标题条目。MK字典中的"RC"。更多...

	e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon
	悬停图标条目。MK字典中的"RI"。更多...

	e_MKEntryRotation = _fsdk.Annot_e_MKEntryRotation
	旋转条目。MK字典中的"R"。

	e_MKRelationCaptionAboveIcon = _fsdk.Annot_e_MKRelationCaptionAboveIcon
	标题在图标上方。

	e_MKRelationCaptionBelowIcon = _fsdk.Annot_e_MKRelationCaptionBelowIcon
	标题在图标下方。

	e_MKRelationCaptionLeft = _fsdk.Annot_e_MKRelationCaptionLeft
	标题在图标左侧。

	e_MKRelationCaptionOvrlayOnIcon = _fsdk.Annot_e_MKRelationCaptionOvrlayOnIcon
	标题直接覆盖在图标上。

	e_MKRelationCaptionRight = _fsdk.Annot_e_MKRelationCaptionRight
	标题在图标右侧。

	e_MKRelationNoCaption = _fsdk.Annot_e_MKRelationNoCaption
	无标题；仅图标。

	e_MKRelationNoIcon = _fsdk.Annot_e_MKRelationNoIcon
	无图标；仅标题。

	e_Movie = _fsdk.Annot_e_Movie
	注释类型：电影注释。<PDF参考1.7>中的标准注释之一。

	e_Note = _fsdk.Annot_e_Note
	注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。

	e_PagingSeal = _fsdk.Annot_e_PagingSeal
	注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。

	e_Polygon = _fsdk.Annot_e_Polygon
	注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。

	e_PolyLine = _fsdk.Annot_e_PolyLine
	注释类型：折线注释。<PDF参考1.7>中的标准注释之一。

	e_Popup = _fsdk.Annot_e_Popup
	注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。

	e_PrinterMark = _fsdk.Annot_e_PrinterMark
	注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。

	e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor
	注释属性：边框颜色。更多...

	e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate
	注释属性：创建日期。更多...

	e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor
	注释属性：填充颜色更多...

	e_PropertyModifiedDate = _fsdk.Annot_e_PropertyModifiedDate
	注释属性：修改日期。

	e_PSInk = _fsdk.Annot_e_PSInk
	注释类型：压力敏感墨迹注释。

	e_Redact = _fsdk.Annot_e_Redact
	注释类型：编辑注释。

	e_RichMedia = _fsdk.Annot_e_RichMedia
	注释类型：富媒体注释。

	e_Screen = _fsdk.Annot_e_Screen
	注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。

	e_Sound = _fsdk.Annot_e_Sound
	注释类型：声音注释。<PDF参考1.7>中的标准注释之一。

	e_Square = _fsdk.Annot_e_Square
	注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。

	e_Squiggly = _fsdk.Annot_e_Squiggly
	注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。

	e_Stamp = _fsdk.Annot_e_Stamp
	注释类型：印章注释。<PDF参考1.7>中的标准注释之一。

	e_StrikeOut = _fsdk.Annot_e_StrikeOut
	注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。

	e_TrapNet = _fsdk.Annot_e_TrapNet
	注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。

	e_Underline = _fsdk.Annot_e_Underline
	注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。

	e_UnknownType = _fsdk.Annot_e_UnknownType
	注释类型：未知。

	e_Watermark = _fsdk.Annot_e_Watermark
	注释类型：水印注释。<PDF参考1.7>中的标准注释之一。

	e_Widget = _fsdk.Annot_e_Widget
	注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。更多...

详细描述

注释将对象（如注记、声音或电影）与PDF文档页面上的位置关联起来，或提供通过鼠标和键盘与用户交互的方式。PDF包含各种各样的标准注释类型。
类Annot 是所有PDF注释类型的基类。它提供获取/设置注释公共属性、移动注释或重置注释外观流的基础函数。对于具体的注释类型，请参考派生类。要获取注释计数或获取/添加/移除注释，请参考类pdfPDFPage。
此类对象也可用于构造其他类的对象，以便在注释中进行更多操作或访问注释的指定信息：

要访问附加动作，请使用注释对象构造FoxitPDFSDKPython3.AdditionalAction 对象。只有少数类型的注释可能有附加动作。有关更多详细信息，请参考类FoxitPDFSDKPython3.AdditionalAction 。
要在注释中搜索文本，请使用注释对象构造FoxitPDFSDKPython3.TextSearch 对象。搜索只能支持某些类型的注释。有关更多详细信息，请参考类FoxitPDFSDKPython3.TextSearch 。

注解

目前，以下类型的函数仅支持注记、高亮、下划线、删除线、波浪线、链接、矩形、圆形、自由文本、印章、插入符、墨迹、直线、多边形、折线、文件附件、弹出窗口、小组件、屏幕、PSInk、编辑注释：

类Annot 中的所有"set"函数。
函数FoxitPDFSDKPython3.Annot.Move 、FoxitPDFSDKPython3.Annot.ResetAppearanceStream 、 FoxitPDFSDKPython3.Annot.RemoveProperty 。

参见: FoxitPDFSDKPython3.PDFPage; FoxitPDFSDKPython3.AdditionalAction; FoxitPDFSDKPython3.TextSearch

构造及析构函数说明

◆ Annot()

def FoxitPDFSDKPython3.Annot.Annot ( annot )

构造函数，使用另一个注释对象。

参数

[in] annot 另一个注释对象。

成员函数说明

◆ GetAppearanceStream()

def FoxitPDFSDKPython3.Annot.GetAppearanceStream	(	type,
		appearance_state
	)

获取具有指定类型和状态的注释外观流。

有关更多详细信息，请参考 <PDF参考1.7> 中 "表8.15 所有注释字典通用条目"中的"AP"和"AS"条目。

参数

[in]	type	注释外观类型。请参考 FoxitPDFSDKPython3.Annot.e_AppearanceTypeNormal 及相关值。
[in]	appearance_state	注释的外观状态，用于从外观子字典中选择适用的外观流。如果为空字符串，Foxit PDF SDK 将选择注释字典中"AS"（外观状态）条目指定的外观状态。

返回: 指定的注释外观流。如果没有与外观相关的条目或发生任何错误，此函数将返回 null。

◆ GetBorderColor()

def FoxitPDFSDKPython3.Annot.GetBorderColor ( )

获取边框颜色。

此属性对注释的外观有影响。

返回: 边框颜色。格式：0xRRGGBB。如果找不到边框颜色，将返回0x000000。

◆ GetBorderInfo()

def FoxitPDFSDKPython3.Annot.GetBorderInfo ( )

获取边框信息。

此属性对注释的外观有影响。对于没有边框信息的注释，将返回默认边框信息：
边框宽度 = 1，边框样式 = FoxitPDFSDKPython3.BorderInfo.e_Solid ，边框云状强度 = 0，边框虚线相位 = 0，边框虚线数组为空数组。注意：在支持的注释类型中（请参考类 Annot 的"注意"注释部分），此属性对以下注释的外观不起作用：注记、高亮、下划线、删除线、波浪线、印章、插入符、弹出窗口、文件附件、PSInk、编辑。对于墨迹注释，只有边框宽度对墨迹注释的外观有影响。

返回: 接收边框信息的边框信息对象。如果找不到任何边框信息，将返回"详细信息"部分所述的默认边框信息。

◆ GetContent()

def FoxitPDFSDKPython3.Annot.GetContent ( )

获取内容。

返回: 内容字符串。

◆ GetDeviceRect()

def FoxitPDFSDKPython3.Annot.GetDeviceRect ( matrix )

获取设备坐标系统中的注释矩形。

这是获取注释的设备矩形的有用函数，但不支持弹出注释。
对于矩形转换，结果矩形始终是"标准化的"，即使用设备坐标系统：左侧始终小于右侧，顶部始终小于底部。

参数

[in] matrix 用于从转换到设备坐标系统的矩阵。通常，这由函数 FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix 返回，也用于渲染。

返回: 设备坐标系统中的注释矩形。如果没有矩形信息，将返回所有值为0的RectI对象。

◆ GetDict()

def FoxitPDFSDKPython3.Annot.GetDict ( )

获取注释的字典对象。

返回: 注释的字典。如果有任何错误，此函数将返回null。

◆ GetDisplayMatrix()

def FoxitPDFSDKPython3.Annot.GetDisplayMatrix ( page_display_matrix )

获取显示矩阵，从到目标设备坐标系统。

当前注释的显示矩阵可以与注释的矩形一起使用，以计算注释在目标设备坐标系统中的实际区域。

参数

[in] page_display_matrix The transformation matrix. Usually this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix .

返回: The display matrix of current annotation.

◆ GetFlags()

def FoxitPDFSDKPython3.Annot.GetFlags ( )

获取注释标志。

返回: 注释标志。请参考从FoxitPDFSDKPython3.Annot.e_FlagInvisible 开始的值，这将是这些值中的一个或组合。0表示无注释标志。

◆ GetIndex()

def FoxitPDFSDKPython3.Annot.GetIndex ( )

获取当前注释在其所属页面中的索引。

返回: 索引值，从0开始。

◆ GetModifiedDateTime()

def FoxitPDFSDKPython3.Annot.GetModifiedDateTime ( )

获取最后修改日期时间。

返回: 接收最后修改日期时间的日期和时间对象。如果没有修改日期时间信息，将返回所有值为0的日期和时间对象。

◆ GetOptionalContent()

def FoxitPDFSDKPython3.Annot.GetOptionalContent ( )

获取注释可选内容的PDF字典。

返回: 注释可选内容的PDF字典。如果没有"OC"条目或发生任何错误，此函数将返回 null。

◆ GetPage()

def FoxitPDFSDKPython3.Annot.GetPage ( )

获取相关的PDF页面。

返回: 作为相关PDF页面的PDF页面对象。

◆ GetRect()

def FoxitPDFSDKPython3.Annot.GetRect ( )

获取矩形，以表示。

返回: 注释矩形。如果没有矩形信息，将返回所有值为0的RectF对象。

◆ GetType()

def FoxitPDFSDKPython3.Annot.GetType ( )

获取当前注释的实际注释类型。

返回: 注释类型。请参考从FoxitPDFSDKPython3.Annot.e_Note 开始的值，这将是这些值中的一个。

◆ GetUniqueID()

def FoxitPDFSDKPython3.Annot.GetUniqueID ( )

获取唯一ID。

返回: 唯一ID字符串。

◆ HasProperty()

def FoxitPDFSDKPython3.Annot.HasProperty ( property )

当前注释是否具有指定的注释属性。

参数

[in] property 属性名称。请参考从FoxitPDFSDKPython3.Annot.e_PropertyModifiedDate 开始的值，这应该是这些值中的一个。

返回: true表示当前注释具有指定的属性，而false表示当前注释没有指定的属性。

◆ IsEmpty()

def FoxitPDFSDKPython3.Annot.IsEmpty ( )

检查当前对象是否为空。

当当前对象为空时，这意味着当前对象是无用的。

返回: true表示当前对象为空，而false表示不为空。

◆ IsMarkup()

def FoxitPDFSDKPython3.Annot.IsMarkup ( )

检查当前注释是否为标记注释。

返回: true表示当前注释是标记注释，而false表示当前注释不是标记注释。

◆ Move() [1/2]

def FoxitPDFSDKPython3.Annot.Move ( rect )

将当前注释移动到新位置，由中的新矩形指定。

参数

[in] rect 指定当前注释要移动到的新位置的新矩形。它应该在中有效。

返回: true表示成功，而false表示失败。

◆ Move() [2/2]

def FoxitPDFSDKPython3.Annot.Move	(	rect,
		is_reset_appearance
	)

将当前注释移动到新位置，由中的新矩形指定。

参数

[in]	rect	指定当前注释要移动到的新位置的新矩形。它应该在中有效。
[in]	is_reset_appearance	布尔值，指定移动后是否重置注释的外观。

返回: true表示成功，而false表示失败。

◆ RemoveProperty()

def FoxitPDFSDKPython3.Annot.RemoveProperty ( property )

删除指定的注释属性。

此函数可用于删除注释的某些可选属性。当成功删除与外观相关的属性时，例如 FoxitPDFSDKPython3.Annot.e_PropertyBorderColor 和 FoxitPDFSDKPython3.Annot.e_PropertyFillColor ，用户应调用函数 FoxitPDFSDKPython3.Annot.ResetAppearanceStream 以在注释外观上产生效果。

参数

[in] property 属性名称。请参考从 FoxitPDFSDKPython3.Annot.e_PropertyModifiedDate 开始的值，应为这些值中的一个。

返回: true 表示成功删除指定属性，或当前注释支持该属性但没有该属性。
false 表示当前注释不支持拥有指定属性，或当前注释无法删除指定属性。

◆ ResetAppearanceStream()

def FoxitPDFSDKPython3.Annot.ResetAppearanceStream ( )

重置外观流。

注释的外观作为流存储在PDF文档中。任何与外观相关的属性都可以通过相应的设置函数进行更改。为了使此更改生效，应调用此函数来更新注释的外观。
请查看类 Annot 注释中的"注意"部分，了解哪些类型的注释可以通过当前函数重置外观，并检查这些注释类的注释，以了解在重置外观流之前是否需要任何属性。

返回: true 表示成功，false 表示失败。

注释的外观作为流存储在PDF文档中。任何与外观相关的属性都可以通过相应的设置函数进行更改。为了使此更改生效，应调用此函数来更新注释的外观。
请查看类 Annot 注释中的"注意"部分，了解哪些类型的注释可以通过当前函数重置外观，并检查这些注释类的注释，以了解在重置外观流之前是否需要任何属性。

参数

[in] is_generate_new_appearance_obj true 表示生成新的外观对象来重置当前注释的外观， false 表示重置共享此外观流的注释的外观。该参数仅对小组件注释的外观有影响。

返回: true 表示成功，false 表示失败。

◆ SetBorderColor()

def FoxitPDFSDKPython3.Annot.SetBorderColor ( color )

设置边框颜色。

此属性对注释的外观有影响。如果用户希望新的边框颜色对注释的外观有影响，请在设置新边框颜色后调用函数FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。

参数

[in] color 要设置的新边框颜色。格式：0xRRGGBB。

返回: 无。

◆ SetBorderInfo()

def FoxitPDFSDKPython3.Annot.SetBorderInfo ( border )

设置边框信息。

此属性对注释的外观有影响。如果用户希望新的边框信息对注释的外观有影响，请在设置新边框信息后调用函数 FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。
注意：在支持的注释类型中（请参考类 Annot 的"注意"注释部分），此属性对以下注释的外观不起作用：注记、高亮、下划线、删除线、波浪线、印章、插入符、弹出窗口、文件附件、PSInk、编辑。对于墨迹注释，只有边框宽度对墨迹注释的外观有影响。

参数

[in] border 要设置的新边框信息。应为有效的边框信息对象。如果参数 border 的任何值无效，此函数将无法为当前注释设置新边框信息。

返回: 无。

◆ SetContent()

def FoxitPDFSDKPython3.Annot.SetContent ( content )

设置内容。

对于自由文本注释和直线注释（已启用标题），它们会在外观中显示内容。因此，对于这些类型的注释，此属性会影响注释的外观。如果用户希望效果显示在这些类型注释的外观中，请在设置新内容后调用函数FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。

参数

[in] content 要设置的新内容字符串。

返回: 无。

◆ SetFlags()

def FoxitPDFSDKPython3.Annot.SetFlags ( flags )

设置注释标志。

参数

[in] flags 注释标志。可以是0，或者是从 FoxitPDFSDKPython3.Annot.e_FlagInvisible 开始的值中的一个或组合。

返回: 无。

◆ SetModifiedDateTime()

def FoxitPDFSDKPython3.Annot.SetModifiedDateTime ( date_time )

设置最后修改日期时间。

参数

[in] date_time 要设置的数据时间。它应该包含有效的日期时间数据。

返回: 无。

◆ SetUniqueID()

def FoxitPDFSDKPython3.Annot.SetUniqueID ( unique_id )

设置唯一ID。

参数

[in] unique_id 要设置的新唯一ID字符串。

返回: 无。

类成员变量说明

◆ e_FlagHidden

FoxitPDFSDKPython3.Annot.e_FlagHidden = _fsdk.Annot_e_FlagHidden

static

注释标志：隐藏。

如果设置，不显示或打印注释或允许用户与其交互，无论其注释类型如何或是否有可用的注释处理程序。

◆ e_FlagInvisible

FoxitPDFSDKPython3.Annot.e_FlagInvisible = _fsdk.Annot_e_FlagInvisible

static

注释标志：不可见。

如果设置，当注释不属于标准注释类型且没有可用的注释处理程序时，不显示该注释。如果清除，则使用其外观字典指定的外观流显示此类非标准注释（如果有）。

◆ e_FlagLocked

FoxitPDFSDKPython3.Annot.e_FlagLocked = _fsdk.Annot_e_FlagLocked

static

注释标志：锁定。

如果设置，不允许用户删除注释或修改其属性（包括位置和大小）。但是，此标志不限制对注释内容的更改，例如表单字段的值。

◆ e_FlagLockedContents

FoxitPDFSDKPython3.Annot.e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents

static

注释标志：锁定内容。

如果设置，不允许用户修改注释的内容。此标志不限制删除注释或更改其他注释属性，例如位置和大小。

◆ e_FlagNoRotate

FoxitPDFSDKPython3.Annot.e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate

static

注释标志：无旋转。

如果设置，不根据页面的旋转旋转注释的外观。注释矩形的左上角在页面上保持固定位置，无论页面旋转如何。

◆ e_FlagNoView

FoxitPDFSDKPython3.Annot.e_FlagNoView = _fsdk.Annot_e_FlagNoView

static

注释标志：无视图。

如果设置，不在屏幕上显示注释或允许用户与其交互。注释可能被打印（取决于标志FoxitPDFSDKPython3.Annot.e_FlagPrint 的设置），但在屏幕显示和用户交互方面应被视为隐藏。

◆ e_FlagNoZoom

FoxitPDFSDKPython3.Annot.e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom

static

注释标志：无缩放。

如果设置，不根据页面的放大倍数缩放注释的外观。注释在页面上的位置（由其注释矩形的左上角定义）保持固定，无论页面放大倍数如何。

◆ e_FlagPrint

FoxitPDFSDKPython3.Annot.e_FlagPrint = _fsdk.Annot_e_FlagPrint

static

注释标志：打印。

如果设置，打印页面时打印注释。如果清除，从不打印注释，无论它是否显示在屏幕上。这可能很有用，例如，对于表示交互式按钮的注释，这些按钮在打印页面上没有意义。

◆ e_FlagReadOnly

FoxitPDFSDKPython3.Annot.e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly

static

注释标志：只读。

如果设置，不允许注释与用户交互。注释可能显示或打印（取决于标志FoxitPDFSDKPython3.Annot.e_FlagNoView 和FoxitPDFSDKPython3.Annot.e_FlagPrint 的设置），但不应响应鼠标点击或响应鼠标移动而改变其外观。

注解: 对于小组件注释，此标志被忽略；其功能被相关表单字段的标志 FoxitPDFSDKPython3.Field.e_FlagReadOnly 取代。

◆ e_FlagToggleNoView

FoxitPDFSDKPython3.Annot.e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView

static

注释标志：切换无视图。

如果设置，为某些事件反转NoView标志的解释。一个典型用途是使注释仅在鼠标光标悬停在其上时出现。

◆ e_MKEntryDownCaption

FoxitPDFSDKPython3.Annot.e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption

static

按下标题（或备用标题）条目。MK字典中的"AC"。

注解: 仅适用于与按钮字段关联的小组件注释。

◆ e_MKEntryDownIcon

FoxitPDFSDKPython3.Annot.e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon

static

按下图标（或备用图标）条目。MK字典中的"IX"。

注解: 仅适用于与按钮字段关联的小组件注释。

◆ e_MKEntryIconCaptionRelation

FoxitPDFSDKPython3.Annot.e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation

static

图标和标题关系条目。MK字典中的"TP"。

注解: 仅适用于与按钮字段关联的小组件注释。用于指定小组件注释的mk标题文本相对于小组件注释的mk图标的位置。

◆ e_MKEntryIconFit

FoxitPDFSDKPython3.Annot.e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit

static

图标适配信息条目。MK字典中的"IF"。

注解: 仅适用于与按钮字段关联的小组件注释。

◆ e_MKEntryNormalCaption

FoxitPDFSDKPython3.Annot.e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption

static

正常标题条目。MK字典中的"CA"。

注解: 仅适用于与按钮字段、复选框字段或单选按钮字段关联的小组件注释。

◆ e_MKEntryNormalIcon

FoxitPDFSDKPython3.Annot.e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon

static

正常图标条目。MK字典中的"I"。

注解: 仅适用于与按钮字段关联的小组件注释。

◆ e_MKEntryRolloverCaption

FoxitPDFSDKPython3.Annot.e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption

static

悬停标题条目。MK字典中的"RC"。

注解: 仅适用于与按钮字段关联的小组件注释。

◆ e_MKEntryRolloverIcon

FoxitPDFSDKPython3.Annot.e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon

static

悬停图标条目。MK字典中的"RI"。

注解: 仅适用于与按钮字段关联的小组件注释。

◆ e_PropertyBorderColor

FoxitPDFSDKPython3.Annot.e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor

static

注释属性：边框颜色。

自由文本注释可以具有边框颜色属性，但不支持从自由文本注释中删除此属性。

◆ e_PropertyCreationDate

FoxitPDFSDKPython3.Annot.e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate

static

注释属性：创建日期。

只有标记注释可以具有创建日期属性。

◆ e_PropertyFillColor

FoxitPDFSDKPython3.Annot.e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor

static

注释属性：填充颜色

只有以下类型的注释可以具有填充颜色属性：
正方形、圆形、自由文本、线条、多边形、折线、编辑。

◆ e_Widget

FoxitPDFSDKPython3.Annot.e_Widget = _fsdk.Annot_e_Widget

static

注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。

注解: 福昕PDF SDK将小组件注释视为表单控件。

Public 成员函数

静态 Public 属性

详细描述

构造及析构函数说明

◆ Annot()

成员函数说明

◆ GetAppearanceStream()

◆ GetBorderColor()

◆ GetBorderInfo()

◆ GetContent()

◆ GetDeviceRect()

◆ GetDict()

◆ GetDisplayMatrix()

◆ GetFlags()

◆ GetIndex()

◆ GetModifiedDateTime()

◆ GetOptionalContent()

◆ GetPage()

◆ GetRect()

◆ GetType()

◆ GetUniqueID()

◆ HasProperty()

◆ IsEmpty()

◆ IsMarkup()

◆ Move() [1/2]

◆ Move() [2/2]

◆ RemoveProperty()

◆ ResetAppearanceStream()

◆ SetBorderColor()

◆ SetBorderInfo()

◆ SetContent()

◆ SetFlags()

◆ SetModifiedDateTime()

◆ SetUniqueID()

类成员变量说明

◆ e_FlagHidden

◆ e_FlagInvisible

◆ e_FlagLocked

◆ e_FlagLockedContents

◆ e_FlagNoRotate

◆ e_FlagNoView

◆ e_FlagNoZoom

◆ e_FlagPrint

◆ e_FlagReadOnly

◆ e_FlagToggleNoView

◆ e_MKEntryDownCaption

◆ e_MKEntryDownIcon

◆ e_MKEntryIconCaptionRelation

◆ e_MKEntryIconFit

◆ e_MKEntryNormalCaption

◆ e_MKEntryNormalIcon

◆ e_MKEntryRolloverCaption

◆ e_MKEntryRolloverIcon

◆ e_PropertyBorderColor

◆ e_PropertyCreationDate

◆ e_PropertyFillColor

◆ e_Widget